home *** CD-ROM | disk | FTP | other *** search
/ Risc World 3 / Risc World 3.iso / SOFTWARE / ISSUE4 / ZAP / !Zap / Modules / !ZapMan / !Help next >
Text File  |  2002-05-08  |  4KB  |  142 lines
  1.                         ------------------------------
  2.                          ZapMan v0.12 (17 April 1998)
  3.                               © David O'Shea 1998
  4.                         ------------------------------
  5.  
  6. Warning:
  7. --------
  8.  
  9.  If you are going to use this with UnixFS, see the Problems heading below!!!!
  10.  
  11.  
  12. Description:
  13. ------------
  14.  
  15.  ZapMan is a Zap mode for reading Unix style 'man' pages. This mode is still
  16. in major development, so there are bound to be bugs. Please let me know if
  17. you find one that's not listed below.
  18.  
  19.  The mode now has a menu, which just executes the commands in brackets. See
  20. below for descriptions of what they do.
  21.  
  22.  Search...               (Man_Search)
  23.  Selection -> Regular    (Man_Regular)
  24.           Bold       (Man_Bold)
  25.           Underline  (Man_Underline)
  26.  
  27.  For an example, take a look at !ZapMan.manpage in both text and man modes.
  28.  
  29.  
  30. Installation: (You need at least !Zap 1.36 to use this mode)
  31. -------------
  32.  
  33.  Simply drag the !ZapMan directory into the !Zap.Modules directory and add the
  34. following two lines near the top of your ClickSend file:
  35.  
  36. | This causes a manpage to be looked up (ZapMan)
  37. &600    .    \[A-Za-z0-9_().]\%    Man_Search    =Man
  38.  
  39. You don't have to add this, but it's very useful! Just Alt+Double click on a
  40. command name referenced in the man page, and it will be looked up.
  41.  
  42.  
  43. Commands:
  44. ---------
  45.  
  46.  As well as giving you a Man mode, this module supplies 4 commands.
  47. These are:
  48.  
  49.  * Man_Search <string>
  50.  
  51.    This command can be used to find a man page. You can supply an optional
  52.    section if you wish.
  53.    
  54.    Eg: Man_Search "Mail(1)" - find Mail in section 1
  55.        Man_Search "biff"    - find biff in any section
  56.    
  57.    The path searched is "Man:" (<Man$Path>), modify it in the !ZapMan.!Setup
  58.    file. The supplied one is for UnixFS.
  59.    
  60.  
  61.  * Man_Regular
  62.  
  63.    This will convert the selected region to regular text, removing all bold
  64.    and underline.
  65.    
  66.  
  67.  * Man_Bold
  68.  
  69.    This will convert any regular text in the selected region to bold text.
  70.    
  71.  
  72.  * Man_Underline
  73.  
  74.    This will convert any regular text in the selected region to underlined
  75.    text.
  76.    
  77.  
  78. Problems:
  79. ---------
  80.  
  81.  Due to the fact that man pages are designed to be viewed at a width of 80
  82. characters, you cannot change the window width from 80, as this would only
  83. mess up the display. This is also due to a bit of a hack at the moment. I'm
  84. working on it... Also due to this, you can keep typing off the end of a line,
  85. and you won't be able to see what's happenning. Currently, you'll just have
  86. to hit return, or have word-wrap turned on, to get around this.
  87.  
  88.  Due to what seems to be a problem in UnixFS (at least in v0.12), if you look
  89. up a few man pages, or have a longish Man$Path specification, and the page
  90. you want is near the end, the machine may hang, and need a reboot. As far as
  91. I can tell, this is purely a UnixFS problem, since opening a few files in
  92. basic seems to hang the machine too. So, save any important work before you
  93. look up a page!
  94.  
  95.  You have been warned!
  96.  
  97.  
  98. Thanks:
  99. -------
  100.  
  101.  Thanks to all on zap-devel for their bug reports, interest and ideas, and
  102. especially Tim Tyler for his suggestions.
  103.  
  104.  
  105. To do: (probably in this order)
  106. ------
  107.  
  108.  * Allow user to change bold & underline styles as well as colours.
  109.  
  110.  * Fix the major hack of logical/physical line handling.
  111.  
  112.  * Fix TAB handling.
  113.  
  114.  
  115.  
  116. History:
  117. --------
  118.  
  119.  v0.12    17 April 1998
  120.      Fixed the 'modified file' flag bug.
  121.      Typing next to a bold or underlined word now inserts in that style.
  122.  
  123.  v0.11    26 March 1998
  124.         Added a sample manpage.
  125.      Fixed /some/ redraw bugs with long lines - it doesn't crash anymore.
  126.      (but with very long lines, the display sometimes gets messed up)
  127.      Mode now takes note of return char setting.
  128.  
  129.  v0.10    24 March 1998
  130.      Added MAN_REGULAR, MAN_BOLD, MAN_UNDERLINE.
  131.      Added a mode menu.
  132.      Added some insertion/deletion handling.
  133.  
  134.  v0.01    18 March 1998
  135.      First version, read-only, one command (MAN_SEARCH).
  136.  
  137.  
  138. Contact:
  139. --------
  140.  
  141.  David O'Shea (d.oshea@cs.ucc.ie)
  142.